Electronic Manual - YourShop IDTracker
© SunnyScript

 

Table of contents

Install the software on your server | How it works (script.cgi) | Advanced feature (returnid.cgi & returnid.htm) | Customer support
 

Install the software on your server

Software configuration...

Open script.cgi and returnid.cgi in a text editor and follow the configuration instructions included within the files. While script.cgi is required in any case, returnid.cgi is an optional tool (read below and decide yourself if you need it).

Transfer files to server...

Start a ftp or telnet session (telnet should be preferred). Then go to the /cgi-bin directory of your server (or use a place where you can execute cgi). Copy the following files in this directory:
  script.cgi --> Main program (rename it if you wish)
  returnid.cgi --> Set cookie for use with an other domain (optional)

Now you must set the file permissions to 755 (executable). On telnet, just type in the following at the command prompt:
  chmod 755 script.cgi [Press Enter]
  chmod 755 returnid.cgi [Press Enter]          (optional)

You're ready !


 
How it works

The affiliate id and URL...

By calling the script, a cookie containing the affiliate id will be set and the user will be redirected to the specified URL. Now the cookie (affiliate id) can be read out at any time using a form (e.g. your order forms). Please read the following instructions:

1. You must create a unique identification for each affiliate. It doesn't matter how long it is and can contain letters as well as numbers (be careful with special characters and avoid spaces). We suggest a small database like an address book to manage all affiliate information (name and address, e-mail, id, payment contact, ...).

2. When this work is done, you can create the URL that links from the associate's website to yours. It may look similar like this one (replace AffiliateID with the identifications of your affiliates):
  http://www.sunnyscript.com/cgi-bin/script.cgi?id=AffiliateID

The associate adds this URL to his / her website. If a visitor clicks on it, our software will set a cookie called "AFFILIATE" and brings the visitor directly to your website.

Read out the affiliate identification (cookie) using forms...

As explained, a cookie called "AFFILIATE" containing the affiliate id as value will be set on visitor's computer. It can be read out later (e.g. in your order forms) by using the JavaScripts located in the file js.txt delivered with the package.

Add the first part in the head of the concerned webpage (before tag </head>) and add the second part inside the form (after the initializing <form> tag).

These two scripts generates a hidden field called "AFFILIATE_ID" containing the cookie as value, which will be processed together with all other form fields. In this way you can determine the affiliate that is associated with the order / form submission.
 

Congratulations - you have finished installation and configuration of the YourShop IDTracker !

 
Advanced feature (returnid.cgi & returnid.htm)

Set cookie with one domain and read it from an other...

Due to security restrictions, cookies can be read out only by the same domain name that originally sets it. If you want to read the cookie from a different domain (e.g. secure order forms) but use your domain name for the affiliate URLs, you must configure returnid.cgi and returnid.htm:

1. Install script.cgi on the server where the cookie should be read out (e.g. secure server) and returnid.cgi on your main server (in our example sunnyscript.com). Copy returnid.htm to the web-directory of the main server (where returnid.cgi is located).

2. Open script.cgi and returnid.cgi in a text editor and follow the configuration instructions included within the files.

3.Open returnid.htm in a text editor and change the line <!--#exec cgi="/cgi-bin/returnid.cgi"--> that it reflects the correct path to returnid.cgi. The refresh tag in the head must contain the URL where visitors are redirected after the cookie is set. Due to optical reasons the variable "homepage" in script.cgi should contain the same URL (but will be ignored completely in this case).

4. The URLs for your affiliates looks like
  http://www.sunnyscript.com/returnid.htm?id=AffiliateID

Important note: This method requires SSI (server side includes) enabled on the server (ask your provider for more information). It may be necessary to rename returnid.htm to returnid.shtml or similar, depending on the way your server handles SSI.

How does returnid.cgi and returnid.htm work ?

Technically, returnid.htm sends the affiliate's identification to returnid.cgi. Now a cookie is set using the domain where script.cgi is installed (of course, you must tell returnid.cgi about this domain - look to the installation part inside the script).

In case of errors with SSL or SSI: Try the alternative solution...

For example some SSL servers does not allow access without encryption (http://... instead of https://...) and other systems may not be able to handle SSI calls. But the YourShop IDTracker will also run on such systems:

Install script.cgi on the server (URL) you want to read out the affiliate id (e.g. secure server). Change the configuration variable $homepage (located in script.cgi) that it points to a webpage on this server containing a redirection to your normal website.

In this way you can read out the affiliate id from the other server (URL) later without using returnid.cgi & returnid.htm.


 
Customer support

The YourShop IDTracker comes with unlimited installation support and free 60-days-support.

If you have a question, please read this manual first. Perhaps you find the answer here. But if you still experience problems, we will more than happy to help you. Please contact our customer support via e-mail (support@sunnyscript.com).

Now we wish you a great time with the YourShop IDTracker :-)


 
© SunnyScript - A subsidiary of Star Enterprise.
Please read the legal agreements located at... http://www.sunnyscript.com/terms.htm